The Command Reference list
Snak comes with many built in commands – way too many to describe here, and
on top of that comes all the aliases (user defined commands that extend the built
in ones).
Snak provides a convenient location where you can browse all the available commands
and learn what they do. In addition to commands and aliases it can also be useful
to know what variables that the various scripts and aliases define, and what built
in functions are available.
When you write scripts you can take advantage of built in functions. Built in
functions are not commands because you can not call functions directly from the
command line. They can only be called from with in a script (which you can then
call from the command line). The full list of functions is displayed in the last
group in the command reference window.
In this example you can see some of the many commands that are available to you.
You will notice two different kinds of descriptions in the list. The first, exemplified
by SIGNOFF – Synonym for /QUIT is that of a built in command. The second
is that of SING which is an alias. An alias is a user defined command made up
of a snippet of script. For an alias, the command reference will display the script
snippet.
You can learn about scripting and how to read script snippets in the scripting
chapters.
I’ll briefly explain that particular alias since I brought it up. The "if"
tests if you have provided a parameter and in that case the /sing command will
output "/me sings <the parameter you provided>". If you did not
provide a parameter then /sing will output the generic "/me sings "O
sole mio""
Each profile in Snak has its own collection of commands and variables and connections
can’t reference each others contents. Therefore there is a popup menu in
the command reference window to switch between the various profiles.
Each profile loads the contents of the scriptfiles alias and basical when it is
created, so the connections will have a common subset of commands. In addition
to that you may load the PurePak script package into one connection but not another.
Then you would see a significant difference in the command reference list for
the various connections.